Skip to content

Enhance STM library readability - Golden tests #2642

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 13 commits into from
Oct 13, 2025
Merged

Enhance STM library readability - Golden tests #2642

merged 13 commits into from
Oct 13, 2025

Conversation

@curiecrypt
Copy link
Collaborator

@curiecrypt curiecrypt commented Jul 16, 2025 •
edited by jpraynaud
Loading

Content

This PR includes "golden" (de)serialization tests for several core types in the mithril-stm crate, ensuring that their JSON representations remain stable and correct:

  • BLS multi signature:
    • Proof of possession
    • Signature
    • Signing key
    • Verification key
  • Participant:
    • Initializer
  • Single signature:
    • Signature
    • Signature with registered party
  • Aggregate signature:
    • Concatenation proof

Note

This is a preliminary work that will help avoid introducing breaking changes in the protocol when the fields of the structures are renamed.

Pre-submit checklist

  • Branch
    • Tests are provided (if possible)
    • Crates versions are updated (if relevant)
    • CHANGELOG file is updated (if relevant)
    • Commit sequence broadly makes sense
    • Key commits have useful messages
  • PR
    • All check jobs of the CI have succeeded
    • Self-reviewed the diff
    • Useful pull request description
    • Reviewer requested

Issue(s)

Closes #2568

@github-actions
Copy link

github-actions bot commented Jul 16, 2025 •
edited
Loading

Test Results

    4 files  ± 0    164 suites  ±0   24m 9s ⏱️ +8s
2 204 tests + 9  2 204 ✅ + 9  0 💤 ±0  0 ❌ ±0 
6 787 runs  +27  6 787 ✅ +27  0 💤 ±0  0 ❌ ±0 

Results for commit 5dddb47. ± Comparison against base commit d7ce977.

This pull request removes 1 and adds 10 tests. Note that renamed tests count towards both. 
mithril-stm ‑ aggregate_signature::signature::tests::aggregate_signature_type::golden_bytes_encoding_prefix

mithril-stm ‑ aggregate_signature::signature::tests::aggregate_signature_golden_concatenation::golden_conversions
mithril-stm ‑ aggregate_signature::signature::tests::aggregate_signature_type_golden::golden_bytes_encoding_prefix
mithril-stm ‑ bls_multi_signature::proof_of_possession::tests::golden::golden_conversions
mithril-stm ‑ bls_multi_signature::signature::tests::golden::golden_conversions
mithril-stm ‑ bls_multi_signature::signing_key::tests::golden::golden_conversions
mithril-stm ‑ bls_multi_signature::verification_key::tests::golden::golden_conversions
mithril-stm ‑ parameters::tests::golden::golden_conversions
mithril-stm ‑ participant::initializer::tests::golden::golden_conversions
mithril-stm ‑ single_signature::signature::tests::golden::golden_conversions
mithril-stm ‑ single_signature::signature_registered_party::tests::golden::golden_conversions

♻️ This comment has been updated with latest results.

jpraynaud
jpraynaud reviewed Jul 16, 2025
View reviewed changes
@curiecrypt curiecrypt temporarily deployed to testing-preview July 18, 2025 15:51 — with GitHub Actions Inactive
@curiecrypt curiecrypt temporarily deployed to testing-preview July 18, 2025 16:20 — with GitHub Actions Inactive
@jpraynaud jpraynaud mentioned this pull request Sep 18, 2025
Closed
20 tasks
@jpraynaud jpraynaud mentioned this pull request Oct 2, 2025
Merged
10 tasks
@jpraynaud jpraynaud force-pushed the curiecrypt/golden-tests branch from dbd1bfd to 377d0d1 Compare October 7, 2025 16:38
@jpraynaud jpraynaud requested a review from Copilot October 7, 2025 16:38
Copilot AI reviewed Oct 7, 2025
View reviewed changes
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR enhances the Mithril STM library by adding golden tests across multiple modules to improve readability and maintainability. Golden tests are a form of regression testing that validate serialization/deserialization behavior by comparing against expected JSON outputs.

Key changes include:

  • Implementation of golden tests for cryptographic components and data structures
  • Addition of PartialEq implementation for the Initializer struct
  • Extension of test dependencies to include serde_json

Reviewed Changes

Copilot reviewed 9 out of 10 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
mithril-stm/src/single_signature/signature_registered_party.rs Adds golden tests for SingleSignatureWithRegisteredParty serialization
mithril-stm/src/single_signature/signature.rs Adds golden tests for SingleSignature serialization
mithril-stm/src/participant/initializer.rs Implements PartialEq and adds golden tests for Initializer
mithril-stm/src/parameters.rs Adds golden tests for Parameters serialization
mithril-stm/src/bls_multi_signature/verification_key.rs Adds golden tests for BLS verification key serialization
mithril-stm/src/bls_multi_signature/signing_key.rs Adds golden tests for BLS signing key serialization
mithril-stm/src/bls_multi_signature/signature.rs Adds golden tests for BLS signature serialization
mithril-stm/src/bls_multi_signature/proof_of_possession.rs Adds golden tests for BLS proof of possession serialization
mithril-stm/Cargo.toml Adds serde_json as test dependency

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@jpraynaud jpraynaud marked this pull request as ready for review October 8, 2025 13:56
jpraynaud
jpraynaud approved these changes Oct 8, 2025
View reviewed changes
Copy link
Member

@jpraynaud jpraynaud left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

curiecrypt
curiecrypt commented Oct 10, 2025
View reviewed changes
Copy link
Collaborator Author

@curiecrypt curiecrypt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

@jpraynaud jpraynaud merged commit d671644 into main Oct 13, 2025
106 of 108 checks passed
@jpraynaud jpraynaud deleted the curiecrypt/golden-tests branch October 13, 2025 06:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@jpraynaud jpraynaud jpraynaud approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Enhance STM library readability - 1/2

3 participants

@curiecrypt @jpraynaud